home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dgelss.z / dgelss
Encoding:
Text File  |  2002-10-03  |  5.8 KB  |  199 lines

  1.  
  2.  
  3.  
  4. DDDDGGGGEEEELLLLSSSSSSSS((((3333SSSS))))                                                          DDDDGGGGEEEELLLLSSSSSSSS((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DGELSS - compute the minimum norm solution to a real linear least squares
  10.      problem
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE DGELSS( M, N, NRHS, A, LDA, B, LDB, S, RCOND, RANK, WORK,
  14.                         LWORK, INFO )
  15.  
  16.          INTEGER        INFO, LDA, LDB, LWORK, M, N, NRHS, RANK
  17.  
  18.          DOUBLE         PRECISION RCOND
  19.  
  20.          DOUBLE         PRECISION A( LDA, * ), B( LDB, * ), S( * ), WORK( * )
  21.  
  22. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  23.      These routines are part of the SCSL Scientific Library and can be loaded
  24.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  25.      directs the linker to use the multi-processor version of the library.
  26.  
  27.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  28.      4 bytes (32 bits). Another version of SCSL is available in which integers
  29.      are 8 bytes (64 bits).  This version allows the user access to larger
  30.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  31.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  32.      only one of the two versions; 4-byte integer and 8-byte integer library
  33.      calls cannot be mixed.
  34.  
  35. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  36.      DGELSS computes the minimum norm solution to a real linear least squares
  37.      problem: Minimize 2-norm(| b - A*x |).
  38.  
  39.      using the singular value decomposition (SVD) of A. A is an M-by-N matrix
  40.      which may be rank-deficient.
  41.  
  42.      Several right hand side vectors b and solution vectors x can be handled
  43.      in a single call; they are stored as the columns of the M-by-NRHS right
  44.      hand side matrix B and the N-by-NRHS solution matrix X.
  45.  
  46.      The effective rank of A is determined by treating as zero those singular
  47.      values which are less than RCOND times the largest singular value.
  48.  
  49.  
  50. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  51.      M       (input) INTEGER
  52.              The number of rows of the matrix A. M >= 0.
  53.  
  54.      N       (input) INTEGER
  55.              The number of columns of the matrix A. N >= 0.
  56.  
  57.      NRHS    (input) INTEGER
  58.              The number of right hand sides, i.e., the number of columns of
  59.              the matrices B and X. NRHS >= 0.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDGGGGEEEELLLLSSSSSSSS((((3333SSSS))))                                                          DDDDGGGGEEEELLLLSSSSSSSS((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      A       (input/output) DOUBLE PRECISION array, dimension (LDA,N)
  75.              On entry, the M-by-N matrix A.  On exit, the first min(m,n) rows
  76.              of A are overwritten with its right singular vectors, stored
  77.              rowwise.
  78.  
  79.      LDA     (input) INTEGER
  80.              The leading dimension of the array A.  LDA >= max(1,M).
  81.  
  82.      B       (input/output) DOUBLE PRECISION array, dimension (LDB,NRHS)
  83.              On entry, the M-by-NRHS right hand side matrix B.  On exit, B is
  84.              overwritten by the N-by-NRHS solution matrix X.  If m >= n and
  85.              RANK = n, the residual sum-of-squares for the solution in the i-
  86.              th column is given by the sum of squares of elements n+1:m in
  87.              that column.
  88.  
  89.      LDB     (input) INTEGER
  90.              The leading dimension of the array B. LDB >= max(1,max(M,N)).
  91.  
  92.      S       (output) DOUBLE PRECISION array, dimension (min(M,N))
  93.              The singular values of A in decreasing order.  The condition
  94.              number of A in the 2-norm = S(1)/S(min(m,n)).
  95.  
  96.      RCOND   (input) DOUBLE PRECISION
  97.              RCOND is used to determine the effective rank of A.  Singular
  98.              values S(i) <= RCOND*S(1) are treated as zero.  If RCOND < 0,
  99.              machine precision is used instead.
  100.  
  101.      RANK    (output) INTEGER
  102.              The effective rank of A, i.e., the number of singular values
  103.              which are greater than RCOND*S(1).
  104.  
  105.      WORK    (workspace/output) DOUBLE PRECISION array, dimension (LWORK)
  106.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  107.  
  108.      LWORK   (input) INTEGER
  109.              The dimension of the array WORK. LWORK >= 1, and also:  LWORK >=
  110.              3*min(M,N) + max( 2*min(M,N), max(M,N), NRHS ) For good
  111.              performance, LWORK should generally be larger.
  112.  
  113.              If LWORK = -1, then a workspace query is assumed; the routine
  114.              only calculates the optimal size of the WORK array, returns this
  115.              value as the first entry of the WORK array, and no error message
  116.              related to LWORK is issued by XERBLA.
  117.  
  118.      INFO    (output) INTEGER
  119.              = 0:  successful exit
  120.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  121.              > 0:  the algorithm for computing the SVD failed to converge; if
  122.              INFO = i, i off-diagonal elements of an intermediate bidiagonal
  123.              form did not converge to zero.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDGGGGEEEELLLLSSSSSSSS((((3333SSSS))))                                                          DDDDGGGGEEEELLLLSSSSSSSS((((3333SSSS))))
  137.  
  138.  
  139.  
  140. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  141.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  142.  
  143.      This man page is available only online.
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.